/**
 * DLA/Oscilloscope Project Software
 * 
 * By Kevin Cuzner <kevincuzner@yahoo.com>
 * 
 * This file is part of the DLA/Oscilloscope Project Software.
 *
 * The DLA/Oscilloscope Project Software is free software: you can 
 * redistribute it and/or modify it under the terms of the GNU Lesser
 * General Public License as published by the Free Software Foundation,
 * either version 3 of the License, or (at your option) any later version.
 *
 * The DLA/Oscilloscope Project Software is distributed in the hope
 * that it will be useful, but WITHOUT ANY WARRANTY; without even the
 * implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with The DLA/Oscilloscope Project Software.
 * If not, see <http://www.gnu.org/licenses/>.
 */

using System;

namespace DLAOscilloscopegtk
{
	/// <summary>
	/// Interface to be implemented by classes describing analog data sets or
	/// analog functions
	/// </summary>
	public interface IAnalogChannel
	{
		/// <summary>
		/// Returns the value for a point at a specific time x
		/// </summary>
		/// <returns>
		/// The <see cref="System.Double"/> value at the point X.
		/// </returns>
		/// <param name='x'>
		/// The point to get a value for
		/// </param>
		double GetPointAt(int x);
		
		/// <summary>
		/// Returns the value for a point at a specific time x based on one or
		/// more arguments. This may be removed
		/// </summary>
		/// <returns>
		/// The <see cref="System.Double"/>.
		/// </returns>
		/// <param name='x'>
		/// X.
		/// </param>
		/// <param name='arguments'>
		/// Arguments.
		/// </param>
		double GetPointAt(int x, params double[] arguments);
		
		/// <summary>
		/// Gets or sets the base time in Hz for this channel. The channel will automatically
		/// interpolate its data to fit the timebase specified here regardless of the time base
		/// or sampling frequency of the data itself.
		/// </summary>
		/// <value>
		/// The time base.
		/// </value>
		ulong TimeBase {
			get;
			set;
		}
		
		/// <summary>
		/// Returns the time base that the samples associated with this channel were recorded
		/// in.
		/// </summary>
		/// <value>
		/// The native time base.
		/// </value>
		ulong NativeTimeBase {
			get;
		}
		
		/// <summary>
		/// Gets or Sets the offset in raw data units of the 0V value
		/// </summary>
		/// <value>
		/// The zero.
		/// </value>
		double Zero {
			get;
			set;
		}
		
		/// <summary>
		/// Gets or Sets the number of raw data units to 1V.
		/// </summary>
		/// <value>
		/// The scaling.
		/// </value>
		double Scaling {
			get;
			set;
		}
	}
}

